<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python documentation Index' />
<link rel="first" href="lib.html" title='Python library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="prev" href="module-MimeWriter.html" />
<link rel="parent" href="module-MimeWriter.html" />
<link rel="next" href="module-mimify.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name='aesop' content='information' />
<title>7.7.1 MimeWriter Objects </title>
</head>
<body>
<div class="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="7.7 mimewriter  "
  href="module-MimeWriter.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="7.7 mimewriter  "
  href="module-MimeWriter.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="7.8 mimify  "
  href="module-mimify.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-MimeWriter.html">7.7 MimeWriter  </a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-MimeWriter.html">7.7 MimeWriter  </a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-mimify.html">7.8 mimify  </a>
</div>
<hr /></div>
</div>
<!--End of Navigation Panel-->

<h2><a name="SECTION009710000000000000000"></a><a name="MimeWriter-objects"></a>
<br>
7.7.1 MimeWriter Objects 
</h2>

<p>
<tt class="class">MimeWriter</tt> instances have the following methods:

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-1532' xml:id='l2h-1532' class="method">addheader</tt></b>(</nobr></td>
  <td><var>key, value</var><big>[</big><var>, prefix</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Add a header line to the MIME message. The <var>key</var> is the name of
the header, where the <var>value</var> obviously provides the value of the
header. The optional argument <var>prefix</var> determines where the header 
is inserted; "<tt class="samp">0</tt>" means append at the end, "<tt class="samp">1</tt>" is insert at
the start. The default is to append.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-1533' xml:id='l2h-1533' class="method">flushheaders</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Causes all headers accumulated so far to be written out (and
forgotten). This is useful if you don't need a body part at all,
e.g. for a subpart of type <span class="mimetype">message/rfc822</span> that's (mis)used
to store some header-like information.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-1534' xml:id='l2h-1534' class="method">startbody</tt></b>(</nobr></td>
  <td><var>ctype</var><big>[</big><var>, plist</var><big>[</big><var>, prefix</var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Returns a file-like object which can be used to write to the
body of the message.  The content-type is set to the provided
<var>ctype</var>, and the optional parameter <var>plist</var> provides
additional parameters for the content-type declaration. <var>prefix</var>
functions as in <tt class="method">addheader()</tt> except that the default is to
insert at the start.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-1535' xml:id='l2h-1535' class="method">startmultipartbody</tt></b>(</nobr></td>
  <td><var>subtype</var><big>[</big><var>,
                   boundary</var><big>[</big><var>, plist</var><big>[</big><var>, prefix</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Returns a file-like object which can be used to write to the
body of the message.  Additionally, this method initializes the
multi-part code, where <var>subtype</var> provides the multipart subtype,
<var>boundary</var> may provide a user-defined boundary specification, and
<var>plist</var> provides optional parameters for the subtype.
<var>prefix</var> functions as in <tt class="method">startbody()</tt>.  Subparts should be
created using <tt class="method">nextpart()</tt>.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-1536' xml:id='l2h-1536' class="method">nextpart</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Returns a new instance of <tt class="class">MimeWriter</tt> which represents an
individual part in a multipart message.  This may be used to write the 
part as well as used for creating recursively complex multipart
messages. The message must first be initialized with
<tt class="method">startmultipartbody()</tt> before using <tt class="method">nextpart()</tt>.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-1537' xml:id='l2h-1537' class="method">lastpart</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
This is used to designate the last part of a multipart message, and
should <em>always</em> be used when writing multipart messages.
</dl>

<div class="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="7.7 mimewriter  "
  href="module-MimeWriter.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="7.7 mimewriter  "
  href="module-MimeWriter.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="7.8 mimify  "
  href="module-mimify.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-MimeWriter.html">7.7 MimeWriter  </a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-MimeWriter.html">7.7 MimeWriter  </a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-mimify.html">7.8 mimify  </a>
</div>
</div>
<hr />
<span class="release-info">Release 2.5.1, documentation updated on 18th April, 2007.</span>
</div>
<!--End of Navigation Panel-->
<address>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</address>
</body>
</html>
